home *** CD-ROM | disk | FTP | other *** search
/ AEMail 2.40 / AEMail v2.40.iso / arexx / subscribe.readme < prev    next >
Text File  |  1999-03-24  |  4KB  |  103 lines
  1. Name: subscribe.aem
  2.  
  3. TO BE USED BY REGISTERED USER'S ONLY
  4.  
  5. This ARexx script is used to add names to a group entry in the Address Book 
  6. for individuals that subscribe or unsubscribe to a mailing list.
  7.  
  8. When individuals wish to subscribe to a mailing list they place "subscribe"
  9. and the mailing list name in the body of a message.
  10.  
  11. To unsubscribe, they would place "unsubscribe" and the name of the mailing
  12. list in the body of the message.
  13.  
  14.                              HOW TO IMPLEMENT
  15.                              ----------------
  16.  
  17. This is a generic script that can be used to set up multiple mailing lists.
  18. There are certain rules you must follow for this script to work.  You could
  19. probably develop a simpler script for a subscription to a specific mailing
  20. list without requiring the rules set forth here.  These rules make the
  21. script generic.
  22.  
  23. The rules:
  24.  
  25.     (1) You must set up a folder for the subscribe/unsubscribe messages.
  26.         This folder must have a body filter that contains:
  27.  
  28.             "subscribe  *[mailing-list-name]"
  29.  
  30.         and should be case insensitive.  This filter will capture both
  31.         subscibe and unsubscribe messages and direct them to this folder.
  32.         Please note the two spaces and the * following "subscribe".  This
  33.         allows any number (but a least one) spaces to separate "subscribe"
  34.         from the mailing list name.
  35.  
  36.     (2) The short name given to this folder must match the Nickname for the
  37.         mailing list group in your address book.  You must create a group
  38.         in your Address book for the mailing list BEFORE executing this
  39.         script.  That is because the script searches for a group Nickname
  40.         that matches the short folder name that contains the
  41.         subscribe/unsubscribe messages.
  42.  
  43.  
  44. This script is probably best placed in your REXX: directory.  If you wish
  45. to modify this script please note the following items:
  46.  
  47.     Avoid any variable names that might match an AEMail ARexx command or a
  48.         standard ARexx command.
  49.  
  50.     Note the use of "'" surrounding the email variable in the EXTRACT
  51.         command.  This will pass the single quote to AEMail surrounding the
  52.         name extracted from the FROM string.  AEMail will strip the single
  53.         quote preserving any double quotes which might surround the name in
  54.         the FROM string.  If you were to use '"' instead of "'", the proper
  55.         action would not occur.
  56.  
  57.     The PARSE command will extract the variable "listname".  That vaiable
  58.         is not used with this script.  If you use this variable to identify
  59.         the list be sure and strip any beginning or ending spaces from the
  60.         variable.
  61.  
  62.  
  63.                            WHAT THE SCRIPT DOES
  64.                            --------------------
  65.  
  66. When this script is executed it will obtain a list of all of your folder
  67. names.  It will then match each name to a Address Book group Nickname.  If
  68. a match is found, it will assume that this folder contains subscribe/
  69. unsubscribe messages for this group.
  70.  
  71. The script will then obtain the text body of each NEW message and search
  72. for the subscribe or unsubscribe key word.  If it is a "subscribe" message
  73. it will add the email address in the REPLY-TO or FROM (if REPLY-TO is
  74. missing) header to the mailing list.
  75.  
  76. If it is a "unsubscribe" message it will delete the email address from the
  77. group.
  78.  
  79. It does not matter if a "subscribe" email address is already in the group
  80. or if a "unsubscribe" email address is missing from the group.
  81.  
  82. It can not delete the last address in a group.  It is best to set up the
  83. group with a known email address that you will always know is in the group
  84. (such as your own).
  85.  
  86. After processing the "new" message, the message indicator for read will be
  87. turned on.
  88.  
  89.                                 HOW TO USE
  90.                                 ----------
  91.  
  92.  
  93. After you receive messages simply execute this script.  If any new
  94. "subscribe" or "unsubscribe" messages were received, it will add or delete
  95. them from the Address Book group entry.  If none were received, nothing
  96. happens.
  97.  
  98. It is best to be displaying a message from another folder when you execute
  99. this script.  This will speed up the execution of the script.  If a message
  100. is not being displayed, each time a message is marked as read, the message
  101. list for the folder will be re-displayed.  By displaying a message, you
  102. will avoid this condition.
  103.